Lender Price API Web Service
Lender Price API Web Service / RateGrid Json Schema
In This Topic
    RateGrid Json Schema
    In This Topic
    Overview
    RateGrid
    adjustmentCap : number
    adjustmentCapScript : string
    affordableHousingTypes : Array[string]
    agency : string
    allowedLockGroupChange : Array[string]
    amortizationTerms : integer
    armCaps : string
    armCeiling : number
    armChangeDates : Array[integer]
    armFloorRateFlatValue : number
    armFloorRateType : string
    armLookbackPeriod : integer
    armMargin : number
    armRoundingFactor : string
    armRoundingStractegy : string
    assumption : boolean
    aus : Array[string]
    businessSourceTypes : Array[string]
    closingDays : Array[integer]
    closingDaysAvailable : Array[integer]
    closingDaysShiftMap : object
    compPlan : number
    compPlanDollarRange : CreditDollarRange
    copy : boolean
    creationDate : string
    customFieldMap : object
    daysLockMapping : object
    deactivateMi : boolean
    displayName : string
    disqualified : Array[string]
    disregardFhaLoanLimit : boolean
    dueTerms : integer
    effectiveDate : string
    enable : boolean
    enableMiOverwrite : boolean
    excludeInInterpolationCalc : boolean
    expirationDate : string
    fhaLoanType : string
    ficoModifierCapRange : IntegerRangeLeGe
    fixPaymentOption : string
    gridType : string
    hedgeEnabled : boolean
    holdBack : number
    holdBackDescription : string
    id : ObjectId
    counter : integer
    internal only
    date : string

    The current date.

    internal only

    machineIdentifier : integer
    internal only
    processIdentifier : integer
    internal only
    time : integer
    internal only
    timeSecond : integer
    internal only
    timestamp : integer
    internal only
    importDeleteWhenNotFound : boolean
    interestOnlyMonth : integer
    libor : string
    liborMigratedtoLiborType : boolean
    liborNameConvertedToLiborType : boolean
    liborType : string
    lienPriorityType : string
    limited : boolean
    listOfRateGridSelectedForBlendingWithInfo : object
    loanAmount : DoubleRangeLeGt
    from : number
    null : boolean
    to : number
    loanPlanId : string
    loanPurposes : Array[string]
    loanType : string
    lockExtensions : Array[LockExtension]
    creationDate : string
    days : integer
    id : ObjectId
    modifiedByOverride : string
    points : number
    lockGroup : string
    ltvModifierCapRange : DoubleRangeGeLe
    from : number
    The minimum value for the range.
    to : number
    The maximum value for the range.
    maxCompensation : number
    maxCompensationDollarAmount : number
    maxCompensationScript : string
    maxExportRate : number
    minExportRate : number
    minimumMonthlyPaymentAmount : number
    minimumMonthlyPaymentPercentage : number
    modifiedByOverride : string
    mortgageLimits : Array[string]
    mortgageTypes : Array[string]
    multiDimensionData : MultiDimensionRateData
    dataMatrix : Array[array]
    defaultDayLock : integer
    defaultPrice : number
    xAxis : Array[Range«object»]
    xAxisDataTyep : string
    xAxisName : string
    yAxis : Array[Range«object»]
    yAxisDataTyep : string
    yAxisName : string
    name : string
    nameCombination : string
    note : string
    order : integer
    originalRates : Array[Rate]
    commissionMapByClosingDay : object
    offsheet : boolean
    rate : number
    shiftAdjGroupId : string
    sourceRate : number
    originalesRates : Array[Rate]
    overrideFieldSet : Array[string]
    ownerRatePeriodId : ObjectId
    parallelIO : boolean
    pmiThreshold : number
    pmiTypes : Array[string]
    productCode : string
    propertyTypes : Array[string]
    qmTypes : Array[string]
    qualifyingRate : QualifyingRateSetup
    calculationType : string
    id : ObjectId
    sources : Array[CalculationSource]
    flat : number
    noteSource : string
    useQualRate : boolean
    rateGridBlendingActivated : boolean
    rateGridFrom : ObjectId
    rateShift : number
    rates : Array[Rate]
    ratesHoldback : Array[RateHoldback]
    flatFee : number
    holdbackMapByClosingDay : object
    msr : number
    msrMapByClosingDay : object
    otherMapByClosingDay : object
    rate : number
    rateIdx : number
    specialMortgageOptions : Array[SpecialMortgageOption]
    category : string
    The category of the special mortgage option.
    description : string
    Description of the mortgage option.
    dynamicProperties : object
    enabled : boolean
    Set to True if enabled.
    id : ObjectId
    The mortgage option ID, used for reference. 
    name : string
    Name of the special mortgage option.
    specialtyProduct : string
    terms : Array[integer]
    termsInMonths : boolean
    totalLoanAmount : DoubleRangeLeGt
    vaLoanType : string
    varaiableLoanTypes : Array[string]
    yearlyTerm : number
    Properties
    NameDescriptionData Type
    adjustmentCap number
    adjustmentCapScript string
    affordableHousingTypes Array[string]
    agency string
    allowedLockGroupChange Array[string]
    amortizationTerms integer
    armCaps string
    armCeiling number
    armChangeDates Array[integer]
    armFloorRateFlatValue number
    armFloorRateType string
    armLookbackPeriod integer
    armMargin number
    armRoundingFactor string
    armRoundingStractegy string
    assumption boolean
    aus Array[string]
    businessSourceTypes Array[string]
    closingDays Array[integer]
    closingDaysAvailable Array[integer]
    closingDaysShiftMap object
    compPlan number
    compPlanDollarRange CreditDollarRange
    copy boolean
    creationDate string
    customFieldMap object
    daysLockMapping object
    deactivateMi boolean
    displayName string
    disqualified Array[string]
    disregardFhaLoanLimit boolean
    dueTerms integer
    effectiveDate string
    enable boolean
    enableMiOverwrite boolean
    excludeInInterpolationCalc boolean
    expirationDate string
    fhaLoanType string
    ficoModifierCapRange IntegerRangeLeGe
    fixPaymentOption string
    gridType string
    hedgeEnabled boolean
    holdBack number
    holdBackDescription string
    id ObjectId
    importDeleteWhenNotFound boolean
    interestOnlyMonth integer
    libor string
    liborMigratedtoLiborType boolean
    liborNameConvertedToLiborType boolean
    liborType string
    lienPriorityType string
    limited boolean
    listOfRateGridSelectedForBlendingWithInfo object
    loanAmount DoubleRangeLeGt
    loanPlanId string
    loanPurposes Array[string]
    loanType string
    lockExtensions Array[LockExtension]
    lockGroup string
    ltvModifierCapRange DoubleRangeGeLe
    maxCompensation number
    maxCompensationDollarAmount number
    maxCompensationScript string
    maxExportRate number
    minExportRate number
    minimumMonthlyPaymentAmount number
    minimumMonthlyPaymentPercentage number
    modifiedByOverride string
    mortgageLimits Array[string]
    mortgageTypes Array[string]
    multiDimensionData MultiDimensionRateData
    name string
    nameCombination string
    note string
    order integer
    originalRates Array[Rate]
    originalesRates Array[Rate]
    overrideFieldSet Array[string]
    ownerRatePeriodId ObjectId
    parallelIO boolean
    pmiThreshold number
    pmiTypes Array[string]
    productCode string
    propertyTypes Array[string]
    qmTypes Array[string]
    qualifyingRate QualifyingRateSetup
    rateGridBlendingActivated boolean
    rateGridFrom ObjectId
    rateShift number
    rates Array[Rate]
    ratesHoldback Array[RateHoldback]
    specialMortgageOptions Array[SpecialMortgageOption]
    specialtyProduct string
    terms Array[integer]
    termsInMonths boolean
    totalLoanAmount DoubleRangeLeGt
    vaLoanType string
    varaiableLoanTypes Array[string]
    yearlyTerm number
    See Also
    Lender Price API Web Service

     

     

    © 2025 All Rights Reserved.

    Send comments on this topic.